home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 551 / bdb_12 / bdb.doc < prev    next >
Text File  |  1991-04-13  |  17KB  |  461 lines
  1.                            Book DataBase One
  2.                               version one
  3.  
  4.                     by Timothy Early, Copyright 1990
  5.                            All rights reserved
  6.  
  7.                         Medium or High Resolution
  8.  
  9. PURPOSE:
  10.  
  11.       To provide an efficient and convenient method of cataloguing
  12. and listing my books.  Entry to be as painless as possible.  All data
  13. is stored in memory for speed of sorting and access.  ASCII listings in
  14. various formats to disk for later printing by the most appropriate
  15. means.  (I use the shareware "2columns.prg") Standard GEM protocols 
  16. (mouse, menus, dialogs) for ease of learning and use.  Slightly
  17. relational  for compactness of internal data representation.  Up to
  18. four authors per title.
  19.  
  20.  
  21. PACKING LIST:
  22.  
  23.       The distribution archive contains the following files:
  24.  
  25.                BDB1.PRG       -- Main Program File
  26.                BDB_MED.RSC    -- Medium Resolution Resource File
  27.                BDB_HIGH.RSC   -- High Resolution Resource File
  28.                BDB.DOC        -- This File
  29.  
  30.  
  31. COPYING AND DISTRIBUTION:
  32.  
  33.       This version of the Book DataBase is being released as freeware.
  34. No monetary payment is solicited or expected for your use of the program,
  35. so use it and enjoy!  You may copy and distribute the program freely, but
  36. please keep the necessary files (program, resources, and this documentation)
  37. together and unaltered.  This program may NOT be sold for profit without
  38. the author's written permission.
  39.  
  40.       Your comments and suggestions, however, are solicited, and would be
  41. most welcome.  I can be reached by U.S. Mail at:
  42.                          975 Diamond St.
  43.                          San Diego, CA  92109
  44.  
  45.  
  46.  
  47. WARRANTY:
  48.  
  49.       There is none.  Please be assured that I have done everything in
  50. my power to ensure that this program will work correctly, will not eat
  51. your disks or fry your CPU.  However, wiser heads have suggested that
  52. I include a standard disclaimer.  So, in legalese:
  53.  
  54. This program and manual are distributed "AS IS", without warranty as to
  55. it's performance.  The entire risk as to the quality and performance is
  56. assumed by the user.
  57. THERE IS NO WARRANTY OF MERCHANTABILITY, NO WARRANTY OF FITNESS FOR A
  58. PARTICULAR USE, AND NO WARRANTY OF ANY OTHER KIND, EXPRESS, IMPLIED, OR
  59. STATUTORY.  IN NO EVENT WILL THE AUTHOR BE LIABLE TO YOU OR ANYONE ELSE
  60. FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, SUCH AS, BUT NOT LIMITED
  61. TO, LOSS OF ANTICIPATED PROFITS OR BENEFITS RESULTING FROM THE USE OF
  62. THIS PROGRAM.  SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF
  63. INCIDENTAL OR CONSEQUENTIAL DAMAGES, THUS THE ABOVE LIMITATION MAY NOT
  64. APPLY TO YOU.
  65.  
  66.  
  67. INSTRUCTIONS FOR USE:
  68.  
  69.       The program, resource file(s), and data files (when created) must
  70. be in the same directory.  Adequate space must be available for data
  71. and report files.
  72.  
  73.       > When a updated data file is written to disk, the updated file
  74.       > is written with the extender [.$$$].  If there are no errors
  75.       > in the save procedure, the old file is deleted, and the
  76.       > updated file is renamed with the [.BDB] extender.  Keep this
  77.       > in mind when judging disk space.
  78.  
  79.       When you run the program the first time, you will see an alert
  80. telling you that the program could not find the data files.  Click on
  81. "CREATE" to make the empty data files 'AUTHORS.BDB', 'SERIES.BDB', and
  82. 'BOOKS.BDB'.  You will now be taken to the main program screen, with a
  83. GEM menu bar at the top.  Most menu options have a control or an
  84. alternate key equivalent.  The [^] symbol is for a control-key
  85. combination, and the box symbol is for an alternate-key combination.
  86.  
  87.      > Note for Monochrome users:  The monochrome version of the Quick
  88.      > ST Demo 2.0 seems to have a bug and will not allow v_gtext to
  89.      > output a vertically clipped character.  This affects the redraw
  90.      > of the Report and Help windows when a dialog or desk accessory
  91.      > has been superimposed.
  92.  
  93. DESK dropdown:
  94.  
  95.       BOOK DATABASE ONE
  96.       Shows the title dialog; you already saw it at the start of the
  97.       program.  The "DETAILS" button gives you some details of the
  98.       tools I used to write the program.
  99.  
  100.       DESK ACCESSORIES:
  101.       Your desk accessories are all available from the main program
  102.       screen.
  103.  
  104.  
  105. FILE dropdown:
  106.  
  107.       SAVE DATA      [Control-S]
  108.       Saves Authors, Series, or Books data if they have been changed.
  109.       You must explicitly call this function before leaving the
  110.       program to save any changes.
  111.  
  112.       LOAD DATA      [Control-L]
  113.       Loads all three data files; you will lose any changes made since
  114.       your last SAVE.
  115.  
  116.       QUIT           [Control-Q]
  117.       Exit to desktop.  You will be asked for confirmation and warned
  118.       if your data has not been saved.  Selecting this option when
  119.       viewing a report or the help screen will only close that window.
  120.  
  121.  
  122. ENTRY dropdown:
  123.  
  124.       ENTER TITLES...       [Control-E]
  125.       Begins the book entry procedure for a single volume.
  126.  
  127.       REVIEW / EDIT...      [Control-R]
  128.       Review book records, gives you the option to edit a record.
  129.  
  130.       > Each record represents a single 'title', which is usually (but
  131.       > not always) a discrete volume.  (I use two records for an Ace
  132.       > Double novel, for example.)
  133.  
  134.       EDIT AUTHORS      [Control-A]
  135.       EDIT SERIES       [Control-Z]
  136.       Summons the SELECT dialog to edit or delete an author or series.
  137.       Use the DONE button to end.  If you try to delete an author or 
  138.       series which is in use, you will be notified.  Use the REVIEW / 
  139.       EDIT... option to delete the book.
  140.  
  141.       EDIT SUBJECT      [Control-U]
  142.       EDIT CODES        [Control-C]
  143.       Allows you to customize the SUBJECT dialog and the CODE dialog.
  144.       Subject and code strings are stored in the books.bdb file, so when 
  145.       you create a new book file, you must re-customize them.  Changes
  146.       made here will affect each book with that subject or code.
  147.  
  148.  
  149. SORT dropdown:
  150.  
  151.       DO SORT      [Control-D]
  152.       Forces an immediate sort in the order specified by the SELECTed
  153.       option.
  154.  
  155.  
  156. SELECT dropdown:
  157.  
  158.       Controls both the order of sort and the format of the output
  159.       book report.  The numbers to the right of the option give a
  160.       rough idea of the depth of the sort.
  161.  
  162.       TITLE        [ALTERNATE-T]
  163.       Sorted by title; Report Format 1.  (see Samples)
  164.  
  165.       AUTHOR       [ALTERNATE-A]
  166.       Sorted by author, and title within author.  Report Format 2.
  167.       (see Samples)
  168.  
  169.       SERIES       [ALTERNATE-S]
  170.       Sorted by author, series, and series sequence number.  Books not
  171.       in a series are sorted by title.  Report Format 3. (see Samples)
  172.  
  173.       SUBJECT      [ALTERNATE-U]
  174.       Sorted by subject and title.  Report Format 1.
  175.  
  176.       BINDING      [ALTERNATE-B]
  177.       Sorted by binding, and title within binding.  Report Format 1.
  178.  
  179.       CODE         [ALTERNATE-C]
  180.       Sorted by code, and then title.  Report Format 1.
  181.  
  182.       NUM1         [ALTERNATE-1]
  183.       Sorted by number field one.  Report Format 1.
  184.  
  185.       NUM2         [ALTERNATE-2]
  186.       Sorted by number field two.  Report Format 1.
  187.  
  188.  
  189. REPORT dropdown:
  190.  
  191.       TO DISK      [ALTERNATE-D]
  192.       Writes a file 'BOOKS_n.TXT' to disk in format defined in SELECT,
  193.       where (n) is replaced by the SELECT letter.
  194.  
  195.       TO WINDOW    [ALTERNATE-W]
  196.       Writes report to a GEM window.  Format is analogous to the disk
  197.       report format, but not the same.
  198.  
  199.       STATISTICS   [question mark]
  200.       Displays a dialog which tells you number of books, authors, and
  201.       series on file.  This information is also printed at the top of
  202.       disk report.  Free memory and maximum number of volumes are also
  203.       displayed.  Maximum numbers of authors and series are the same
  204.       as for volumes.
  205.  
  206.       DETAILED STATS      [ALTERNATE-question mark]
  207.       Writes a report to disk with a more detailed breakdown of data
  208.       statistics.  The filename is STATS.TXT.
  209.  
  210.       WRITE AUTHORS      [ALTERNATE- ]
  211.       Writes alphabetical list of authors to disk file 'AUTHORS.TXT'.
  212.  
  213.       WRITE SERIES       [ALTERNATE- ]
  214.       Writes alphabetical list of series to disk file 'SERIES.TXT'.
  215.  
  216.       EXPORT             [ALTERNATE-X]
  217.       A flattened ASCII file with each field of each record on a
  218.       single line.  If the field is blank, a \n is written.  There are
  219.       eighteen lines per record.  No blank lines are written between
  220.       records.
  221.  
  222.  
  223. HELP dropdown:
  224.  
  225.       HELP      [HELP key]
  226.       Opens a window which contains a short version of this document.
  227.  
  228.  
  229. ENTER A TITLE:
  230.  
  231.       When you select "ENTER TITLE..." you are taken through the entry
  232.       procedure.  The first thing that happens is mandatory fields are
  233.       solicited: Author, Type, Binding and Title.  Following this, optional
  234.       fields may be filled in.  Finally, you can either accept the new
  235.       record or cancel the entry.  The process can only be aborted after
  236.       the mandatory fields are entered.
  237.  
  238.    SELECT AUTHOR dialog:
  239.       This is similar to a file select dialog.  The list of authors appear
  240.       in a scrollable window, with the selected author in a box at the the
  241.       top of the dialog.  The selected author cannot be edited.  Choose
  242.       an author in the window by clicking on it; a double-click will
  243.       "ACCEPT" that author.  The "ACCEPT" button will pass the selected
  244.       author to the entry dialog.
  245.  
  246.       If the desired author is not on the list, click on the "ENTER NEW"
  247.       button.  A window will appear to allow you to enter a new author
  248.       name, up to 62 characters.  A very long name will appear truncated
  249.       in subsequent dialogs, but will appear in full on output reports.
  250.  
  251.       > For proper sorting, use the format: LASTNAME, FIRSTNAME
  252.  
  253.       You may edit the selected author by clicking on the name displayed
  254.       in red at the top of the dialog.
  255.  
  256.       The "CLEAR" button will be enabled when it is possible to clear the
  257.       corresponding field in the record.  This option is not available if
  258.       there is only one author specified for a title.
  259.  
  260.       The "CANCEL" button exits the dialog, leaving the original contents
  261.       of the field unchanged.
  262.  
  263.    SUBJECT dialog:
  264.       One of the displayed choices must be selected.
  265.  
  266.    BINDING dialog:
  267.       One of the displayed choices must be selected.
  268.  
  269.       > I tried to account for all common types of binding, so if
  270.       > something is missing, tell me so I can add it.
  271.  
  272.       > Knowing the binding is important to me, as I'll keep different
  273.       > binding type books in different places.
  274.  
  275.       Library bound vs. Book Club:  Many book club hardcover books are
  276.        not bound as well as a 'real' hardcover.  No cloth is used on the
  277.        end boards or spine, a lower quality paper is used, pages are not
  278.        trimmed as well, etc.  Thus, I feel this is a valid distinction
  279.        to make here.
  280.       Trade paperback:  generally, a large-format paperback.
  281.       Paperback: standard formats.
  282.       Spiral Bound:  wire or plastic binding, allows book to lie flat
  283.        when open.
  284.       Binder:  any collection of loose pages between covers, usually
  285.        hole punched for three rings.
  286.  
  287.    ENTRY DIALOG:
  288.  
  289.       TITLE:
  290.       Mandatory field.  Enter up to 60 characters.
  291.  
  292.       > I use a format which puts initial articles last: 
  293.       > "The Complete Sherlock Holmes" becomes "Complete Sherlock Holmes, The"
  294.  
  295.       BY/ED:
  296.       Click here to switch between 'By' (for author) and 'Ed' (for editor).
  297.       '??' disables the corresponding author field (except for primary
  298.       author).
  299.  
  300.       AUTHOR:
  301.       Click when enabled (red border) to enter or change an author.  Calls
  302.       up the "SELECT AUTHOR" dialog.  Use the "BY/ED" field to enable the
  303.       author field.
  304.  
  305.       SERIES:
  306.       Click here to call up the "SELECT SERIES" dialog, which is the same
  307.       as the "SELECT AUTHOR" dialog.  When non-empty, it makes the 
  308.       "SERIES NUMBER" field mandatory.
  309.  
  310.       SERIES NUMBER:
  311.       A three character text entry field for a series sequence number or
  312.       code.  I use letters when I am uncertain of the proper sequence.
  313.  
  314.       SUBJECT:
  315.       Click here to call up the SUBJECT dialog.  Mandatory field.
  316.  
  317.       BINDING:
  318.       Click here to call up the BINDING dialog.  Mandatory field.
  319.  
  320.       CODE:
  321.       Click here to call up the CODE dialog.  Optional field.  This is
  322.       for information which overlaps and supplements the SUBJECT.
  323.  
  324.       NUM 1:
  325.       NUM 2:
  326.       Optional fields for a numeric value between 0-65535.  Can be used
  327.       for an accession number, cover price (assumed decimal), or
  328.       whatever you want.
  329.  
  330.       > Another suggestion for using one of these number fields:
  331.       > Keep a list of people you lend books to; assign each a number.
  332.       > When you loan a book out, update the number field.  Now you can
  333.       > sort and report by the number field, cross reference to your
  334.       > list, and know who has what.
  335.  
  336.       COMMENT:
  337.       Text entry field for up to 60 characters of free-form comments.
  338.  
  339.  
  340. REVIEW / EDIT PROCEDURE:
  341.  
  342.       When you select the "REVIEW/EDIT..." dropdown you are presented with
  343.       a dialog very similar to the volume entry panel, although the
  344.       individual fields are not selectable.  At the bottom of the panel
  345.       are five buttons and a horizontal slider.  The NEXT and PREVIOUS
  346.       buttons (as well as the areas to the left and right of the slider
  347.       control), will sequentially access the file; using the slider allows
  348.       direct access to any record.
  349.  
  350.    EDIT BOOK button
  351.       Switches to the volume entry panel.  Fields can be selected and
  352.       changed or deleted.  Selecting OKAY or CANCEL will return you to
  353.       the REVIEW/EDIT dialog.
  354.  
  355.    DELETE BOOK Button
  356.       It will ask for confirmation, then delete the book record from
  357.       memory.  BE SURE THIS IS WHAT YOU WANT TO DO!  There is no UNDO
  358.       from this action.  Note that the Author and Series remain on their
  359.       respective lists; they may be in use by another volume.
  360.  
  361.    DONE button
  362.       This button ends the REVIEW/EDIT process.
  363.  
  364.  
  365.  
  366.      
  367. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  368. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  369.  
  370.  
  371.       Sample Reports
  372.  
  373.       > Formats are still being refined.
  374.       > These formats apply to the disk report, the formats in the
  375.       > window will be different, but offer essentially the same
  376.       >information.
  377.  
  378. Report Format 1  ---------------------------------------- 
  379.  
  380. 200 Years to Christmas  -- McIntosh, J. T.
  381. [Widget], the [Wadget], and Boff, The  -- Sturgeon, Theodore
  382. Abyss  -- Wilhelm, Kate
  383. Aces Abroad  -- Martin, George R. R.
  384. After Armageddon  -- Pournelle, J. E.
  385. After the Fact  -- Saberhagen, Fred
  386.  
  387. Report Format 2  ---------------------------------------- 
  388.  
  389.  
  390. Aldiss, Brian W.
  391.   Saliva Tree, The 
  392.  
  393. Allen, Roger MacBride
  394.   Torch of Honor 
  395.  
  396. Anderson, Poul
  397.   Circus of Hells, A 
  398.   Cold Victory 
  399.   Earthman's Burden (w/ Dickson, Gordon )
  400.   Explorations 
  401.   Hoka (w/ Dickson, Gordon )
  402.   Orbit Unlimited 
  403.   Past Times 
  404.  
  405.       > NOTES:
  406.       >
  407.       > Secondary authors are listed.
  408.       >
  409.  
  410. Report Format 3  ---------------------------------------- 
  411.  
  412.  
  413. Baen, Jim
  414.      New Destinies, Vol. IV (Winter 1988) (ED) 
  415.      New Destinies, Vol. VII (Spring 1989) (ED) 
  416.      New Destinies, Vol. VIII (Fall, 1989) (ED) 
  417.  
  418. Leemon, Sheldon
  419.  
  420.    Series:  Compute!'s Technical Reference Guide
  421.      1. Atari ST Volume One: The VDI 
  422.  
  423. Leiber, Fritz
  424.      Best of Fritz Leiber, The 
  425.      Ship of Shadows 
  426.        --Tor Double #5; w/ Anderson, Poul 'No Truce with Kings'
  427.      Silver Eggheads, The 
  428.  
  429.    Series:  Fafhrd and the Gray Mouser
  430.      7. Knight and Knave of Swords, The 
  431.  
  432. Leinster, Murray
  433.  
  434.    Series:  Med Series, The  (Combined Edition)
  435.      1. Mutant Weapon, The 
  436.      2. S.O.S. from Three Worlds 
  437.      3. This World is Taboo 
  438.  
  439. Lilly, John C.
  440.      Scientist, The 
  441.  
  442. Niven, Larry
  443.      Shape of Space, The 
  444.  
  445.    Series:  Dream Park
  446.      2. Barsoom Project, The (w/ Barnes, Steven )
  447.  
  448.    Series:  Man-Kzin Wars, The
  449.      1. Man-Kzin Wars, The (w/ Anderson, Poul & Ing, Dean )
  450.  
  451.  
  452.       >
  453.       > NOTES:
  454.       >
  455.       > Multiple series are sorted by series name.
  456.       > Comments are included (see double novel reference).
  457.       > 'Med Series' is a single volume with three records.
  458.       > Secondary author(s) are listed.
  459.       > Title is followed by (ED) for editor.
  460.  
  461.